home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
Shareware Grab Bag
/
Shareware Grab Bag.iso
/
081
/
opuslog.arc
/
OPUS!LOG.DOC
next >
Wrap
Text File
|
1987-08-10
|
32KB
|
758 lines
Opus!Log
Version 2.00 (May, 1987)
Version 2.2x (June, 1987)
Version 2.3x (July, 1987)
Version 2.4x (August, 1987)
(c) Copyright 1987, Satore Center Software
All Rights Reserved
User Documentation
------------------
1.00 - IMPORTANT INFORMATION
This product is militantly Public Domain. You may not charge for the use
or distribution of this product in any manner whatsoever. This product
may not be used in any commerical or profit-making enterprise. It may
not be duplicated or modified in any way except for personal use.
There are no warranties stated or implied. You use this product fully at
your own risk without guarantee as to suitability of purpose.
You need not register to use this program. It is free. We do ask that
you consider a contribution if you use the program regularly. Please send
your contribution to:
Satore Center Software
295 Ulloa Street
San Francisco, CA 94127
Data: (415) 753-3356
You may send bug reports/suggestions to Satore Center by NetMail. Our
net address is 161/521. We make no assertions as to future versions or
any guarantees as to program changes. We will, however, work upon known
bugs and consider suggestions for improvements as time permits. Should
you wish to send a bug report please also netmail the OPUS log and the
output from Opus!Log so we can track the critter down.
Should you have any questions about the use of this program or the import
of its copyright please contact Satore Center Software.
Note: There are always last minute additions. You will find several new
enhancements to this version. Enter OPUS!LOG for a full help screen.
2.00 - PROGRAM OVERVIEW
Opus!Log is a log file analysis system for use with the log created by
OPUS(tm) BBS software. It has been tested with OPUS versions through
Gamma 1d (June, 1987). It is expected that users of Opus!Log will be OPUS
Sysops. Opus!Log will not work with log reports from other BBS systems.
The OPUS(tm) BBS system provides a wealth of log information, especially
when the VERBOSE mode is selected in the OPUS(tm) control file. Human
analysis of this information can be difficult, however, since all OPUS
log entries are in a linear (time relative) format. Opus!Log provides a
multitude of ways to "break out" categories of log information for
analysis. When run on a daily basis Opus!Log will provide a series of
summary reports which will tell the Sysop at a glance what has happened
in the preceeding log period.
Opus!log provides three categories of reports. The first category is a
series of FIXED FORMAT reports discussed in Section 3.00. The second is
a standard STATISTICAL report discussed in Section 4.00. The third is
a user-definable series of reports discussed in Section 5.00. User
defined reports are unlimited both in terms of context and number.
Installation of Opus!Log is discussed in Section 6.00 and is quite
simple. It is strongly recommended that you set your OPUS log output to
VERBOSE in your OPUS control file before using Opus!Log.
3.00 - FIXED FORMAT REPORTS
The reports which follow are all fixed format; that is, their ouput
cannot be changed by the user. They may be selected individually or in
groups as discussed in Section 6.00. Under default conditions Opus!Log
will generate all of these reports (for a discussion of the Opus!Log
default conditions see below). Entering "OPUS!LOG" without any command
line parameters will display a list of the various options. Entering
"OPUS!LOG -ALL" will generate all fixed format reports as discussed in
Section 6.00.
The reports which follow constitue a "basic" series which will provide
all the information a Sysop would normally need regarding BBS activities.
3.01 - File Exchange Summary (Human Callers)
This report provides information on all transactions which involve the
uploading or downloading of files by human callers. If a file was
moved to or from your OPUS system by a user the result will be shown in
this report in the following format:
Opus!Log - Ver. 2.2xn
(C) Copyright 1987, Satore Center Software, [SCS]
------------------------------------------------------------------------------
File Exchange Summary (Human Callers)
------------------------------------------------------------------------------
Date Time Commentary or Description
11 MAY 7:25:39 DAVID COE CALLING
11 May 7:31:58 DL-Y c:\opusdate.arc Size = -32,456
11 May 8:02:20 DL-Y c:\do-flyer.arc Size = - 4,555
11 May 8:03:32 DL-Y c:\do-sysop.arc Size = -12,456
: |
etc. etc.
: |
------------------------------------------------------------------------------
Lines Scanned: 1092 End of Summary
==============================================================================
If a caller uploads a file, that information will be printed in UPPER
CASE. In all instances the size of the file and the cumulative size of
the user's transactions will be displayed.
If the command line switch -TF was used, OPUS!LOG will also append the
filenames to a file called OLOGLIST.TXT on the default drive/directory.
This file is useful for determining file downloading/uploading and files
which are not active. It is in standard ASCII format and suitable for
use by other utility programs.
3.02 - Human Caller Summary Report
A straight forward summary of who called, when they called and how long
they were online. Here is an example:
Opus!Log - Ver. 2.2xn
(C) Copyright 1987, Satore Center Software, [SCS]
------------------------------------------------------------------------------
Human Caller Summary
------------------------------------------------------------------------------
Date Time Commentary or Description
11 May 6:20:13 Mike Kelleher 10 minutes online.
11 May 6:35:27 Lee Fields 15 minutes online.
11 May 7:03:33 Mike Lennig 3 minutes online.
11 May 7:25:39 David Coe 38 minutes online.
11 May 8:08:30 Justin Marquez 17 minutes online.
11 May 8:27:17 Rene Bilodeau 10 minutes online.
11 May 8:56:12 Bill Macneill 14 minutes online.
11 May 9:19:36 Geoffrey Meredith 2 minutes online.
:
:
etc.
:
:
:
------------------------------------------------------------------------------
Lines Scanned: 1120 End of Summary
==============================================================================
This report is simple enough and requires no explanation. At times you
may see a "--" in place of the number of minutes a user was online. This
is normal and simply means that OPUS has not recorded the online time
data.
3.03 - Outgoing Calls Summary Report
Whenever OPUS makes an outgoing call for matrix purposes the details will
be recorded in this report. If a connection is made and traffic is
passed, that will also be recorded and identified with seperator lines.
Opus!Log - Ver. 2.2xn
(C) Copyright 1987, Satore Center Software, [SCS]
------------------------------------------------------------------------------
Outgoing Calls Summary
------------------------------------------------------------------------------
Date Time Commentary or Description
11 May 7:20:18 Calling FOG CITY OPUS (222-3333)................. CONNECT ....
11 May 7:22:08 Flagging c:\002401ff.mo5 as sent :
11 May 7:22:20 Outgoing connect time: 1:37 (125/10) :
................................................... END .....:
11 May 9:34:10 Calling Mike's Place (333-4444).................. CONNECT ....
11 May 9:34:45 Bundle sent to 5210/2 :
11 May 9:34:51 Outgoing connect time: 0:14 (5210/2) :
................................................... END .....:
11 May 12:34:27 Calling FOG CITY OPUS (333-4444)................. CONNECT ....
11 May 12:36:16 Flagging c:\002401ff.mo6 as sent :
11 May 12:36:28 Outgoing connect time: 1:36 (125/10) :
................................................... END .....:
11 May 12:41:08 Calling Harv's Hideout (444-3333)................ CONNECT ....
11 May 12:41:45 Session with Harv's Hideout - San Francisco (0:161/77.0) :
................................................... END .....:
11 May 13:33:14 Calling Mike's Place (444-3333).................. CONNECT ....
11 May 13:33:49 Bundle sent to 5210/2 :
11 May 13:33:53 Outgoing connect time: 0:13 (5210/2) :
................................................... END .....:
11 May 14:16:23 Calling NERD'S NOOK #1 Opu (333-2222)............ CONNECT ....
11 May 14:16:58 Flagging c:\00000208.mo3 as sent :
11 May 14:17:07 UL-S C:\0E110201.PKT :
11 May 14:17:07 Bundle from 161/1 :
11 May 14:17:19 Unpacking sea bundle from 161/1 :
11 May 14:17:21 2 messages :
................................................... END .....:
11 May 15:30:30 Calling FOG CITY OPUS (222-3333)................. CONNECT ....
11 May 15:32:18 Flagging c:\002401ff.mo7 as sent :
11 May 15:32:28 UL-S C:\0F20140D.PKT :
11 May 15:32:28 Bundle from 125/10 :
11 May 15:36:40 UL-S C:\Ffdcfe01.Mo4 :
11 May 15:36:54 ARCE C:\*.MO? :
11 May 15:37:06 Unlink C:\FFDCFE01.MO4 :
11 May 15:37:07 Unpacking oMMM bundle from 125/10 :
11 May 15:37:08 Unpacking oMMM bundle from 125/10 :
11 May 15:38:12 52 messages :
................................................... END .....:
11 May 16:11:25 Calling Mike's Place (333-4444)
11 May 16:26:58 Calling Mike's Place (333-4444)
11 May 16:32:38 Calling Mike's Place (333-4444).................. CONNECT ....
11 May 16:33:14 Bundle sent to 5210/2 :
11 May 16:33:18 Outgoing connect time: 0:13 (5210/2) :
................................................... END .....:
:
:
etc.
:
:
------------------------------------------------------------------------------
Lines Scanned: 1120 End of Summary
==============================================================================
Please note that all outgoing calls are recorded whether or not a
connection is made. If a connection is made it will be identified with
the seperator lines and the keyword "CONNECT". The end of that
connection will likewise be marked as in the example. This allows you to
trace ALL outgoing call activity.
In addition, all activity and exchanges which took place during the
connection will be recorded.
If the command line switch -OC is use, OPUS!LOG will also calculate the
cost of the call based upon the information contained in NODELIST.BBS.
This information will be appended after each completed call. To use this
function the file NODELIST.BBS MUST BE PRESENT on the default
drive/directory.
3.04 - Incoming Matrix Traffic Summary Report
This report is similar to the preceeding one except that it tracks all
incoming matrix activty. Again, it is simple and requires little
explanation:
Opus!Log - Ver. 2.2xn
(C) Copyright 1987, Satore Center Software, [SCS]
------------------------------------------------------------------------------
Incoming Matrix Traffic Summary
------------------------------------------------------------------------------
Date Time Commentary or Description
11 May 7:08:09 Connect 2400 - Incoming Matrix
11 May 7:08:14 Session with Harv's Hideout - San Francisco (0:161/77.0)
11 May 7:08:19 UL-S C:\Private\07081011.PKT
11 May 7:08:19 Bundle from 161/77
11 May 7:09:50 UL-S C:\Private\0000fe44.Mo1
11 May 7:10:06 ARCE C:\Private\*.MO?
11 May 7:10:15 Unlink C:\Private\0000FE44.MO1
11 May 7:10:16 Unpacking oMMM bundle from 161/77
11 May 7:10:17 Unpacking oMMM bundle from 161/77
11 May 7:11:05 50 messages
11 May 8:38:19 Connect 1200 - Incoming Matrix
11 May 8:38:24 TSYNC: Incoming LoTek
11 May 8:38:34 UL-S C:\Private\08261928.PKT
11 May 8:38:35 Bundle from 5210/2
11 May 8:38:47 Unpacking fido bundle from 5210/2
11 May 9:16:44 Connect 1200 - Incoming Matrix
11 May 9:16:50 TSYNC: Incoming LoTek
11 May 9:17:01 UL-S C:\Private\09103301.PKT
11 May 9:17:01 Bundle from 5210/2
11 May 9:17:39 UL-S C:\Private\Dutchie.Cfg
11 May 9:17:48 Unpacking fido bundle from 5210/2
11 May 9:17:49 1 messages
11 May 9:22:45 Connect 1200 - Incoming Matrix
11 May 9:22:50 TSYNC: Incoming LoTek
11 May 9:23:02 UL-S C:\Private\09163320.PKT
11 May 9:23:02 Bundle from 5210/2
11 May 9:23:10 File(s) not sent: No such file or directory
11 May 9:23:14 Unpacking fido bundle from 5210/2
11 May 9:23:16 1 messages
:
etc.
:
------------------------------------------------------------------------------
Lines Scanned: 1046 End of Summary
==============================================================================
Please note that ALL activity which takes place throughout the connection
is recorded. This includes any external processing which you may have
selected to manage incoming netmail or echomail.
3.05 - Log Warning Flag Summary Report
The OPUS log will automatically flag certain activities as unusual.
These are commonly referred to as "warnings". This report summarizes all
such activity, appending the name and date of the caller who generated
the warning entry:
Opus!Log - Ver. 2.2xn
(C) Copyright 1987, Satore Center Software, [SCS]
------------------------------------------------------------------------------
Log Warning Flag Summary
------------------------------------------------------------------------------
Date Time Commentary or Description
11 MAY 8:27:17 RENE BILODEAU CALLING
11 May 8:27:25 Rene Bilodeau isn't in user list
11 MAY 9:19:36 GEOFFREY MEREDITH CALLING
11 May 9:22:22 Modem doesn't report `OK'
11 MAY 9:28:59 CINDY MCCREADY CALLING
11 May 9:34:09 Baud rate??
11 May 9:34:09 Request D=0
11 MAY 16:53:58 BRIAN RODRUCK CALLING
11 May 16:53:59 Bad Pwd `Bkr'
:
:
etc.
:
:
------------------------------------------------------------------------------
Lines Scanned: 1120 End of Summary
==============================================================================
Please refer to your OPUS documentation for a further description of
these various warning messages.
3.07 - Message Area Activity Summary
For those Sysops who like to see a summary of local message traffic, here
is the report you will need:
Opus!Log - Ver. 2.2xn
(C) Copyright 1987, Satore Center Software, [SCS]
------------------------------------------------------------------------------
Message Area Activity Summary
------------------------------------------------------------------------------
Date Time Commentary or Description
11 May 8:27:17 Rene Bilodeau Msg to All, area 2, #36
11 May 9:24:55 Mike Kelleher Msg to Mike, area 11, #3
11 May 9:24:55 Mike Kelleher Matrix charge 25
11 May 9:43:39 Jan Gyn Msg to Cindy Mccready, area 1, #84
11 May 9:55:27 Josh Gordon Msg to Cindy or Mike, area 0, #85
11 May 11:10:13 Ted Decastro Msg to Cindy or Mike, area 1, #86
11 May 11:10:13 Ted Decastro Msg to Cindy or Mike, area 1, #87
11 May 11:10:13 Ted Decastro Msg to Cindy or Mike, area 1, #88
11 May 13:04:51 Cindy Mccready Msg to Jan Gyn, area 1, #89
11 May 13:04:51 Cindy Mccready Msg to Mike Kelleher, area 11, #4
11 May 13:04:51 Cindy Mccready Matrix charge 25
11 May 13:04:51 Cindy Mccready Msg to Josh Gordon, area 1, #90
11 May 13:04:51 Cindy Mccready Msg to Ted Decastro, area 1, #91
11 May 15:52:37 Cindy Mccready Msg to Mike Kelleher, area 11, #8
11 May 15:52:37 Cindy Mccready Matrix charge 25
11 May 16:12:22 Todd Fasnacht Msg to Mike Kelleher, area 2, #37
11 May 16:12:22 Todd Fasnacht Msg to Mike Kelleher, area 2, #38
11 May 16:12:22 Todd Fasnacht Msg to Bill Obrien, area 2, #39
11 May 16:12:22 Todd Fasnacht Msg to Harold Choate, area 2, #40
11 May 16:53:58 Brian Rodruck Msg to Ted Glenwright, area 2, #41
11 May 16:53:58 Brian Rodruck Msg to Ted Glenwright, area 2, #42
:
:
etc.
:
:
------------------------------------------------------------------------------
Lines Scanned: 1120 End of Summary
==============================================================================
Notice that two activities are identified: any individual who leaves a
message and any activity which results in a matrix charge to the users
account.
Note: Since version 2.2x, this report has been expanded and contains
much more information than in the example given above.
3.08 - Log File/Message Area Tracer Report
A very simple report which traces any change in message or file area
undertaken by a user:
Opus!Log - Ver. 2.2xn
(C) Copyright 1987, Satore Center Software, [SCS]
------------------------------------------------------------------------------
Log File/Message Area Tracer
------------------------------------------------------------------------------
Date Time Commentary or Description
11 May 6:35:27 Lee Fields File area 2 Cereal
11 May 6:35:27 Lee Fields File area 1 Openfile
11 May 6:35:27 Lee Fields File area 4 Applicat
11 May 6:35:27 Lee Fields File area 5 Upload
11 May 6:35:27 Lee Fields File area 6 Commerci
11 May 6:35:27 Lee Fields Msg.area 1 General
11 May 6:35:27 Lee Fields Msg.area 2 Opusmsg
11 May 7:03:33 Mike Lennig File area 3 Rebarb
11 May 7:03:33 Mike Lennig File area 5 Upload
11 May 7:25:39 David Coe File area 2 Cereal
11 May 7:25:39 David Coe Msg.area 1 General
11 May 7:25:39 David Coe File area 6 Commerci
11 May 8:08:30 Justin Marquez File area 1 Openfile
11 May 8:27:17 Rene Bilodeau Msg.area 2 Opusmsg
11 May 8:56:12 Bill Macneill Msg.area 2 Opusmsg
11 May 8:56:12 Bill Macneill File area 2 Cereal
11 May 9:19:36 Geoffrey Meredith File area 1 Openfile
11 May 9:43:39 Jan Gyn Msg.area 4 Tech
11 May 10:29:45 Dave Giunti Msg.area 4 Tech
11 May 10:29:45 Dave Giunti Msg.area 6 C_Echo
11 May 10:29:45 Dave Giunti Msg.area 7 Comm
11 May 10:29:45 Dave Giunti Msg.area 1 General
11 May 10:29:45 Dave Giunti Msg.area 2 Opusmsg
11 May 10:29:45 Dave Giunti File area 6 Commerci
11 May 10:29:45 Dave Giunti File area 1 Openfile
11 May 15:04:01 Gary Rux File area 2 Cereal
11 May 15:04:01 Gary Rux File area 1 Openfile
11 May 15:04:01 Gary Rux File area 3 Rebarb
11 May 15:04:01 Gary Rux File area 4 Applicat
11 May 15:04:01 Gary Rux File area 5 Upload
11 May 15:04:01 Gary Rux File area 3 Rebarb
11 May 15:04:01 Gary Rux File area 1 Openfile
:
etc.
:
This report will allow you to trace the activity in various message and
file areas as well as specific user activity.
Note: As with the previous report, since version 2.2x of OPUS!LOG was
released, the contents of this report have been significantly expanded.
4.00 - The Statistical Summary Report
Opus!log also provides a statistical summary report which is available
as a separate report. You are able to pipe this report to an external
file or the printer as with any of the foregoing reports.
The statistical summary report includes information on the following
categories of information:
Incoming Calls
Outoing Calls
Events
Files/Packets Uploaded
Files/Packets Downloaded
Packets Received in NetMail
Unsuccessful Polling Attempts
Warning Lines
Human Callers (count)
Message Received in NetMail
Connects
300/1200/2400/9600 Baud Connects
Length of Average Call
Total Hours Online
Matrix Callers
Local Messages
Log Lines Surveyed
5.00 - User Definable Reports
Opus!Log also allows you to design any number of customized reports which
may be run in addition to the standard reports already described. In
order to make use of this feature you must create a special ASCII control
file with the name OPUS!LOG.RPT. This control file must be located in
the same directory as Opus!log itself (see section 6.00 - Installation).
The control file must contain the following information:
Number of lines to be printed PRIOR to the target line (numeric)
Number of lines to be printed AFTER the target line (numberic)
Target line text (a string)
Title of Report (a string)
NONE OF THIS INFORMATION IS OPTIONAL. Your control file must always
contain these four pieces of information.
Suppose, as an example, we wanted to find every log line which contained
the string "UL-". This would indicate that some file/packet has been
uploaded. Further suppose that we would like to see the five lines
preceeding the target line and the three lines after the target line.
Finally, we will call the report "UPLOAD REPORT". Here is the line which
should be contained in the control file:
5,3,UL-,UPLOAD REPORT
Please note that the string items DO NOT require quotes. If we wished to
ONLY see the line containing the target string we would change the first
two elements to zero like this:
0,0,UL-,UPLOAD REPORT
You may have as many special report lines as you like in the control
file. There is no limitation but your imagination.
Please see Section 7.00 for an example of using this, and the other,
Opus!log options.
6.00 - Installation
The Opus!log executable file should reside in the same directory as your
OPUS log file. If you choose to use the customized report options
mentioned in Section 5.00, your control file should be located in the
same directory. The control file MUST be named OPUS!LOG.RPT.
Opus!Log has been designed to run fully unattended in BATch file mode for
regular processing. It has also been designed to drop back to DOS should
it encounter any unknown error. It is therefore usable in your
RUNBBS.BAT (or whatever) OPUS file for daily processing of your log.
7.00 - Running Opus!Log
Opus!Log runs in a variety of different modes.
First of all it is assumed that your OPUS log file is named either
OPUS.LOG or SYSOP.LOG. If not, please see section 7.10 - Declaring a Log
File Name. By using a log file name of SYSOP.LOG or OPUS.LOG you will
automatically activate the Opus!Log default features (fixed format report
series). With another log file name you must specify which reports are
desired (as discussed below).
Each of the fixed format reports has a special command line switch. You
may declare any combination of reports by including it's command line
switch as appropriate. You many mix and match any number of valid report
command line switches.
Here are the command line switches for the fixed format reports:
-t ..... File and Packet Exchange Summary Report
-tf ..... Same as -T but also create output file list
(creates OLOG.TXT on default drive/directory)
-h ..... Human Caller Summary Report
-o ..... Outgoing Calls Summary Report
-oc ..... Same as -O but also show cost per call data
(requires NODELIST.BBS on default drive/directory)
-i ..... Incoming Matrix Traffic Summary Report
-w ..... Log Warning Flag Summary Report
-m ..... Message Area Activity Summary
-n ..... Show NetMail activity only (-I-O)
-x ..... Log File/Message Area Tracer
-all ..... Run all fixed format reports (except -TF and -OC)
In addition, there are two other command line switches for special
reports which MAY NOT BE MIXED with the fixed format report switches.
-special ..... Invoke the user definable report sequence using
the control file Opus!Log.RPT
-stats ..... Invoke the video statistical summary
These two switches are also mutually exclusive. In other words, you may
mix any or all of the fixed format report switches, however, the "-
special" and "-stats" switchs must ALWAYS stand alone when invoking
Opus!Log.
Here are some example to make this a little easier:
To invoke the statistical summary: Opus!Log -stats
To invoke your customized reports: Opus!Log -special
To see upload/download report : Opus!Log -t
To run all fixed format reports : Opus!Log -all
Here's an example to see ALL the various reports and pipe them to your
printer:
Opus!log -t-h-o-i-w-e-m-x > prn
HOWEVER... if your Opus log is named OPUS.LOG or SYSOP.LOG and you would
like to see ALL of the reports you can simply enter this:
Opus!Log -all > prn
This will have the same effect as the previous example. Remember that
the default mode of Opus!Log is:
... log file name of OPUS.LOG or SYSOP.LOG
Also it is imporant to note that the reports will ALWAYS be displayed on
your video, even when you are using the DOS pipe option to a file or the
printer.
Should you have difficulty remembering any of this, simply enter:
Opus!log or Opus!Log -help or Opus!log -?
and a short help screen will be displayed. You may enter any command
line parameter in either upper or lower case.
7.10 Declaring a Log File Name
Should you use a log file name other than OPUS.LOG or SYSOP.LOG you can
still use Opus!Log; however, the default conditions are therefore
overridden and you MUST declare each report you would like on the command
line. The command line format is:
Opus!Log [logfilename] [report switches]
Opus!Log [logfilename] [special switches]
It is expected that most Sysops will use one of the two default log file
names and therefore this option has only been provided for the
exceptional case.
8.00 Summary
-------
Use Opus!Log in good health. Please send your comment/suggestions to
Satore Center, 161/521 in the Matrix.
Please consider a contribution if you like and use the program...
9.00 Credits and Revision History
----------------------------
Thanks to Harvey Nehgila for banging and suggesting.
Version 1.00 - 1.97 Extreme testing and bug stomping
Version 1.98 Beta
Version 2.00 First Release (limited)
Version 2.2x A series of updates to keep up with the changing
log format of OPUS. A number of improvements were
added, including upgrading the -M and -X reports,
adding the cost option (-OC) and output file report
for transferred files (-TF).
Version 2.3x Brought up to date for OPUS 1.01
Version 2.3x Scripting recognition added
Version 2.4x Added report -g switch for online summary
Version 2.4x First public release
